@twin.org/api-auth-entity-storage-service 0.9.1-next.2 → 0.9.1-next.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/routes/entityStorageAuthenticationAdminRoutes.js +11 -6
- package/dist/es/routes/entityStorageAuthenticationAdminRoutes.js.map +1 -1
- package/dist/es/routes/entityStorageAuthenticationAuditRoutes.js +175 -6
- package/dist/es/routes/entityStorageAuthenticationAuditRoutes.js.map +1 -1
- package/dist/es/services/entityStorageAuthenticationAuditService.js +62 -1
- package/dist/es/services/entityStorageAuthenticationAuditService.js.map +1 -1
- package/dist/types/routes/entityStorageAuthenticationAdminRoutes.d.ts +3 -2
- package/dist/types/routes/entityStorageAuthenticationAuditRoutes.d.ts +28 -3
- package/dist/types/services/entityStorageAuthenticationAuditService.d.ts +19 -0
- package/docs/changelog.md +32 -0
- package/docs/open-api/spec.json +2122 -0
- package/docs/reference/classes/EntityStorageAuthenticationAuditService.md +84 -0
- package/docs/reference/functions/authenticationAdminCreateUser.md +7 -1
- package/docs/reference/functions/authenticationAuditCreate.md +7 -1
- package/docs/reference/functions/authenticationAuditGet.md +31 -0
- package/docs/reference/functions/authenticationAuditRemove.md +31 -0
- package/docs/reference/functions/authenticationAuditUpdate.md +31 -0
- package/docs/reference/index.md +3 -0
- package/locales/en.json +6 -0
- package/package.json +4 -4
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { IAdminUserCreateRequest, IAdminUserGetByIdentityRequest, IAdminUserGetRequest, IAdminUserGetResponse, IAdminUserRemoveRequest, IAdminUserUpdatePasswordRequest, IAdminUserUpdateRequest } from "@twin.org/api-auth-entity-storage-models";
|
|
2
|
-
import type
|
|
2
|
+
import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type ITag } from "@twin.org/api-models";
|
|
3
3
|
/**
|
|
4
4
|
* The tag to associate with the routes.
|
|
5
5
|
*/
|
|
@@ -16,9 +16,10 @@ export declare function generateRestRoutesAuthenticationAdmin(baseRouteName: str
|
|
|
16
16
|
* @param httpRequestContext The request context for the API.
|
|
17
17
|
* @param componentName The name of the component to use in the routes.
|
|
18
18
|
* @param request The request.
|
|
19
|
+
* @param baseRouteName The base route name to use for the location header.
|
|
19
20
|
* @returns The response object with additional http response properties.
|
|
20
21
|
*/
|
|
21
|
-
export declare function authenticationAdminCreateUser(httpRequestContext: IHttpRequestContext, componentName: string, request: IAdminUserCreateRequest): Promise<ICreatedResponse>;
|
|
22
|
+
export declare function authenticationAdminCreateUser(httpRequestContext: IHttpRequestContext, componentName: string, request: IAdminUserCreateRequest, baseRouteName: string): Promise<ICreatedResponse>;
|
|
22
23
|
/**
|
|
23
24
|
* Update an existing user.
|
|
24
25
|
* @param httpRequestContext The request context for the API.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { IAuditCreateRequest, IAuditQueryRequest, IAuditQueryResponse } from "@twin.org/api-auth-entity-storage-models";
|
|
2
|
-
import type
|
|
1
|
+
import type { IAuditCreateRequest, IAuditGetRequest, IAuditGetResponse, IAuditQueryRequest, IAuditQueryResponse, IAuditRemoveRequest, IAuditUpdateRequest } from "@twin.org/api-auth-entity-storage-models";
|
|
2
|
+
import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type ITag } from "@twin.org/api-models";
|
|
3
3
|
/**
|
|
4
4
|
* The tag to associate with the routes.
|
|
5
5
|
*/
|
|
@@ -16,9 +16,34 @@ export declare function generateRestRoutesAuthenticationAudit(baseRouteName: str
|
|
|
16
16
|
* @param httpRequestContext The request context for the API.
|
|
17
17
|
* @param componentName The name of the component to use in the routes.
|
|
18
18
|
* @param request The request.
|
|
19
|
+
* @param baseRouteName The base route name to use for the location header.
|
|
19
20
|
* @returns The response object with additional http response properties.
|
|
20
21
|
*/
|
|
21
|
-
export declare function authenticationAuditCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditCreateRequest): Promise<ICreatedResponse>;
|
|
22
|
+
export declare function authenticationAuditCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditCreateRequest, baseRouteName: string): Promise<ICreatedResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Get an authentication audit entry.
|
|
25
|
+
* @param httpRequestContext The request context for the API.
|
|
26
|
+
* @param componentName The name of the component to use in the routes.
|
|
27
|
+
* @param request The request.
|
|
28
|
+
* @returns The response object with additional http response properties.
|
|
29
|
+
*/
|
|
30
|
+
export declare function authenticationAuditGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditGetRequest): Promise<IAuditGetResponse>;
|
|
31
|
+
/**
|
|
32
|
+
* Update an authentication audit entry.
|
|
33
|
+
* @param httpRequestContext The request context for the API.
|
|
34
|
+
* @param componentName The name of the component to use in the routes.
|
|
35
|
+
* @param request The request.
|
|
36
|
+
* @returns The response object with additional http response properties.
|
|
37
|
+
*/
|
|
38
|
+
export declare function authenticationAuditUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditUpdateRequest): Promise<INoContentResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* Remove an authentication audit entry.
|
|
41
|
+
* @param httpRequestContext The request context for the API.
|
|
42
|
+
* @param componentName The name of the component to use in the routes.
|
|
43
|
+
* @param request The request.
|
|
44
|
+
* @returns The response object with additional http response properties.
|
|
45
|
+
*/
|
|
46
|
+
export declare function authenticationAuditRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditRemoveRequest): Promise<INoContentResponse>;
|
|
22
47
|
/**
|
|
23
48
|
* Query authentication audit entries.
|
|
24
49
|
* @param httpRequestContext The request context for the API.
|
|
@@ -24,6 +24,25 @@ export declare class EntityStorageAuthenticationAuditService implements IAuthent
|
|
|
24
24
|
* @returns The unique identifier of the created audit entry.
|
|
25
25
|
*/
|
|
26
26
|
create(entry: Omit<IAuthenticationAuditEntry, "id" | "dateCreated">): Promise<string>;
|
|
27
|
+
/**
|
|
28
|
+
* Get an audit entry by id.
|
|
29
|
+
* @param id The unique identifier of the audit entry.
|
|
30
|
+
* @returns The audit entry.
|
|
31
|
+
*/
|
|
32
|
+
get(id: string): Promise<IAuthenticationAuditEntry>;
|
|
33
|
+
/**
|
|
34
|
+
* Update an audit entry.
|
|
35
|
+
* @param id The unique identifier of the audit entry to update.
|
|
36
|
+
* @param entry The fields to update on the audit entry.
|
|
37
|
+
* @returns A promise that resolves when the audit entry has been updated.
|
|
38
|
+
*/
|
|
39
|
+
update(id: string, entry: Partial<Omit<IAuthenticationAuditEntry, "id" | "dateCreated">>): Promise<void>;
|
|
40
|
+
/**
|
|
41
|
+
* Remove an audit entry.
|
|
42
|
+
* @param id The unique identifier of the audit entry to remove.
|
|
43
|
+
* @returns A promise that resolves when the audit entry has been removed.
|
|
44
|
+
*/
|
|
45
|
+
remove(id: string): Promise<void>;
|
|
27
46
|
/**
|
|
28
47
|
* Query the audit entries.
|
|
29
48
|
* @param options The query options.
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.1-next.4](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-service-v0.9.1-next.3...api-auth-entity-storage-service-v0.9.1-next.4) (2026-06-30)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* improved rest handling ([#211](https://github.com/iotaledger/twin-api/issues/211)) ([12c50ea](https://github.com/iotaledger/twin-api/commit/12c50ea7655276eed7a73d311ac5286476c98201))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/api-auth-entity-storage-models bumped from 0.9.1-next.3 to 0.9.1-next.4
|
|
16
|
+
* @twin.org/api-core bumped from 0.9.1-next.3 to 0.9.1-next.4
|
|
17
|
+
* @twin.org/api-models bumped from 0.9.1-next.3 to 0.9.1-next.4
|
|
18
|
+
|
|
19
|
+
## [0.9.1-next.3](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-service-v0.9.1-next.2...api-auth-entity-storage-service-v0.9.1-next.3) (2026-06-29)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
* enhanced rest handling ([#208](https://github.com/iotaledger/twin-api/issues/208)) ([99d5f3f](https://github.com/iotaledger/twin-api/commit/99d5f3f96d262e57828d98d3f3b1e3da8a863378))
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Dependencies
|
|
28
|
+
|
|
29
|
+
* The following workspace dependencies were updated
|
|
30
|
+
* dependencies
|
|
31
|
+
* @twin.org/api-auth-entity-storage-models bumped from 0.9.1-next.2 to 0.9.1-next.3
|
|
32
|
+
* @twin.org/api-core bumped from 0.9.1-next.2 to 0.9.1-next.3
|
|
33
|
+
* @twin.org/api-models bumped from 0.9.1-next.2 to 0.9.1-next.3
|
|
34
|
+
|
|
3
35
|
## [0.9.1-next.2](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-service-v0.9.1-next.1...api-auth-entity-storage-service-v0.9.1-next.2) (2026-06-26)
|
|
4
36
|
|
|
5
37
|
|